Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs for equality and DataFrames #27

Merged
merged 1 commit into from
May 3, 2018
Merged

Improve docs for equality and DataFrames #27

merged 1 commit into from
May 3, 2018

Conversation

spurll
Copy link
Contributor

@spurll spurll commented May 3, 2018

Adds documentation detailing some special considerations to be made when comparing Intervals with AnchoredIntervals.

@spurll spurll requested a review from omus May 3, 2018 18:49
Copy link
Collaborator

@omus omus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

#### Equality

Two `AbstractInterval`s are considered equal if they have identical left and right
endpoints (taking `Inclusivity` into account):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be really great to have docstrings for LeftEndpoint and RightEndpoint

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Perhaps the person who wrote those could be convinced to document them... 😛

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya, that guy is a slacker ;). I'll open an issue for this as I don't think I'll have the time at the moment: #28


julia> join(df2, df3; on=:time)
0×3 DataFrames.DataFrame

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra whitespace? I guess this is actually what is produced.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct! It looked weird when I removed it, so I left it in.

@codecov
Copy link

codecov bot commented May 3, 2018

Codecov Report

Merging #27 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #27   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           5      5           
  Lines         183    183           
=====================================
  Hits          183    183

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c98068b...70fe33c. Read the comment docs.

@omus omus merged commit 0ab1091 into master May 3, 2018
@omus omus deleted the gn/improve-docs branch May 3, 2018 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants